Reporting Job form

Administration System Reporting Jobs Reporting Jobs view Reporting Job form

The Reporting Job form enables you to add or edit a reporting job definition that specifies a schedule to run reports at specified time intervals and send the output as an email attachment to specified recipients.

N4 runs a reporting job only after a node starts up. Before adding a reporting job you should make sure that the reporting job configuration settings are set for your scope level.

To add or edit a reporting job:

1. In the General area, in the Id field, enter a unique ID for the reporting job.

2. Optionally, in the Description field, enter a short description for the reporting job.

3. From the Execution Node drop-down list, select the node where N4 must run the reporting job.

N4 executes the reporting job on the selected node in the cluster.

4. In the Job Target area, include the reports to be created when the reporting job is run. For more information, see the steps below to include or exclude a report.

• The list displays only the report definitions that exist at the current scope level and do not have any required parameters specified in the report definition (on page 1) or the report design (on page 1).

5. Optionally, from the Report User drop-down list, select the user you want N4 to use for security purposes when generating the report. If you select a user with an associated business group, N4 will restrict the data in the generated report based on the business group for the selected user.

If an associated business group exists for a user, the business group displays in parenthesis to the right of the user ID.

6. From the Report Language drop-down list, select the language you want N4 to use to display the localized data in the generated report.

If you select a user in step 5, N4 pre-populates the user's language, if specified in the User form (on page 1), in the Report Language drop-down list.

7. From the Execution Scope Level drop-down list, select the scope level at which you want to run the reports selected in step 4.

The drop-down list displays only the current scope level or any lower scope levels. For example, if you are logged in at the facility scope level, you can create a reporting job that runs reports for the facility or a yard in the facility.

8. From the Execution Scope drop-down list, select the specific operator, complex, facility, or yard for the scope level selected in step 5.

The drop-down list displays only the entities for the selected scope level. For example, if you select the yard scope level, the drop-down list displays all the yards defined for the facility at which you are logged in.

9. On the Scheduling tab (on page 1), define a schedule to run the reporting job.

10. On the Notification tab (on page 1), specify the email address of the recipients for the generated report outputs.

11. Click Save.

When you add a reporting job, N4 does not schedule it automatically. In the Reporting Jobs view, you must select the Actions Schedule option to schedule the reporting job.

Each time N4 executes a reporting job, N4 adds a record to the Execution Logs tab (on page 1). The three states of execution of a reporting job are: In Progress, Succeeded, and Failed.

When you run reports containing empty records, N4 updates the status as warning in the State field, sends an e-mail notification to the recipient, and displays the reason for the failure in the Note field in the Job Execution Log form (on page 1). Use the setting ARGOREPORTING010 (REPORTING_EMAIL_NOTIFICATION) to customize this behavior or if you do not want N4 to send email notifications for reports with empty records.

For more information, see Job Execution Logs view (on page 1).

To include a report, you can do any of the following:

If you have a large number of entries in the Excluded field, you can use the Search text box to filter the reports. In the Search text box, type characters to filter the entries in the Excluded field and then use any of the following methods to move the reports from the Excluded field to the Included field:

• Double-click the report in the Excluded field.

• Select the reports in the Excluded field and click .

To select adjoining reports, press and hold the Shift key. To select non-adjoining reports, press and hold the Ctrl key.

• Click to include all reports.

To exclude a report, you can do any of the following:

If you have a large number of entries in the Included field, you can use the Search text box to filter the reports. In the Search text box, type characters to filter the entries in the Included field and then use any of the following methods to move the reports from the Included field to the Excluded field:

• Double-click the report in the Included field.

• Select the reports in the Included field and click .

To select adjoining reports, press and hold the Shift key. To select non-adjoining reports, press and hold the Ctrl key.

• Click to exclude all reports.